home *** CD-ROM | disk | FTP | other *** search
/ Cobra Utilities for Doom & Doom II / Cobra Utilities For Doom & Doom II - Disc 2.iso / files / program / wadtls / wt.doc < prev    next >
Encoding:
Text File  |  1994-01-18  |  7.0 KB  |  208 lines
  1.                                 =========
  2.                                 WAD Tools
  3.                                 =========
  4.                             Documentation
  5.                             Revision 1.00
  6.                               Jan 18 1994
  7.  
  8. Table of Contents
  9. =================
  10.  
  11.    General overview
  12.    Usage/Requirements
  13.    Features
  14.    Future additions
  15.    WAD file specs
  16.    Disclaimer
  17.    Author/Misc info
  18.  
  19.  
  20. General Overview
  21. ================
  22.  
  23.    WAD Tools is a freeware program to be used with id Software's
  24.    phenomenal action game, DOOM. It is designed to let any curious
  25.    individual peruse the contents of the DOOM WAD file. Anyway, WAD 
  26.    Tools will let you do any number of operations on the resources in 
  27.    the WAD file. You can view it in hex mode, or if it's a graphic 
  28.    resource, you can view it in 320x200x256 VGA mode.  You can also 
  29.    export it to a file (an LBM if it's a graphic resource), or replace 
  30.    it by importing a file. And, if you're really brave, you can export 
  31.    all the resources in the WAD file to individual files.
  32.  
  33.  
  34. Usage/Requirements
  35. ==================
  36.  
  37.    To invoke WAD Tools, simply type "WT" at the DOS prompt. You may
  38.    specify an alternate WAD file to use by typing "WT filename".
  39.  
  40.    WAD Tools requires a VGA monitor. I don't do any checking of this
  41.    when the program starts, because I assume that if you are playing
  42.    DOOM, you have a VGA monitor...
  43.  
  44.  
  45. Features
  46. ========
  47.  
  48.    The interface for WAD Tools is extremely simple. You are presented
  49.    with a list box containing the name and size of all the resources in
  50.    the WAD file. Use the arrow keys, PgUp, PgDn, Home and End to
  51.    navigate the list. You can seek to a resource quickly by typing the
  52.    name of it. Hitting a non-alphanumeric key will reset the seek
  53.    string. Esc exits to DOS.  Here are the rest of the commands
  54.    available:
  55.  
  56.    F1 / Enter - View as graphic resource
  57.    =====================================
  58.  
  59.       If the highlighted resource is a graphic resource, it will be
  60.       displayed in 320x200 256-color VGA mode. WAD Tools will attempt
  61.       to discern whether or not it is a graphic resource by checking
  62.       the first two integers in the file, which are the X and Y sizes.
  63.       If they are out-of-range values, i.e. 1112x0, WAD Tools will
  64.       warn you that it is probably not a graphic resource. Continue at
  65.       your own risk. Note: while you are viewing a graphic resource,
  66.       you can switch between the 14 palettes in PLAYPAL using the 'A'
  67.       through 'N' keys.
  68.  
  69.    F2 - View as hex data
  70.    =====================
  71.  
  72.       This will display a dump of the highlighted resource in hex
  73.       values. Use the arrow pad to move around. Pretty simple.
  74.  
  75.    F5 - Export resource
  76.    ====================
  77.  
  78.       This will export the highlighted resource to a file on your hard
  79.       disk.
  80.  
  81.    F6 - Import resource
  82.    ====================
  83.  
  84.       This will import a file off of your hard disk and replace the
  85.       highlighted resource with it. The imported file can't be greater
  86.       in size than the resource you are trying to replace.
  87.  
  88.    F8 - Restore original order
  89.    ===========================
  90.  
  91.       This will put the resource list in the order that is appears in
  92.       the WAD file.
  93.  
  94.    F9 - Sort by name
  95.    =================
  96.  
  97.       This will sort the resource list by resource name.
  98.  
  99.    F10 - Sort by size
  100.    ==================
  101.  
  102.       This will sort the resource list by resource size.
  103.  
  104.    Alt-F1 - Export to LBM
  105.    ======================
  106.  
  107.       If the highlighted resource is a graphic resource (see
  108.       explanation of F1), this will export it to an LBM file. These are
  109.       readable by Deluxe Paint 2 as well as many other popular graphics
  110.       programs.
  111.  
  112.    Alt-F5 - Export all resources
  113.    =============================
  114.  
  115.       This is a batch version of F5. It exports all the resources in
  116.       the WAD file to individual files. They are all written to a
  117.       directory called RESOURCE. This is so you don't write 10 megs
  118.       of files to your DOOM directory. Note:  zero byte resources are
  119.       created as directory names and all the subsequent files will go
  120.       under under this directory.  This is because all the level data
  121.       files have the same names, i.e. LINEDEFS, SECTORS, etc. There is
  122.       one kludge, though: when any BLOCKMAP resource is processed, the
  123.       output directory is reset to RESOURCE. This is so all the
  124.       hundreds of files after the E3M9 resources aren't written to the
  125.       E3M9 directory.
  126.  
  127.  
  128. Future additions
  129. ================
  130.  
  131.    I plan on adding these features in future releases:
  132.  
  133.       Resource editing with the hex viewer
  134.       Full rebuilding of the WAD file
  135.       Sound resource player
  136.       Importing if LBM's to graphic resources
  137.  
  138.    If you have any ideas or suggestions, send some e-mail!
  139.  
  140.  
  141. WAD file specs
  142. ==============
  143.  
  144.    The WAD file itself is just a big library of files with an index at 
  145.    the end. This is the format (as I understand it):
  146.  
  147.       Offset       Description
  148.       ======       ===========
  149.       0            4-byte WAD file signature, "IWAD"
  150.       4            Ctrl-Z
  151.       5            08,00,00 (?)
  152.       8            long int, offset of resource index (x)
  153.       .            resource data ...
  154.       .
  155.       .
  156.       x            index entry 1 offset
  157.       x + 4        index entry 1 size
  158.       x + 8        index entry 1 name
  159.       x + 16       index entry 2 offset
  160.       x + 20       index entry 2 size
  161.       x + 24       index entry 2 name
  162.       .            index entry 3 ...
  163.       .
  164.       .
  165.       EOF
  166.  
  167.    The resource index entry format:
  168.  
  169.       Offset       Description
  170.       ======       ===========
  171.       0            long int, offset in WAD file of data
  172.       4            long int, size of data
  173.       8            8 characters, name or ID
  174.  
  175.  
  176. Disclaimer
  177. ==========
  178.  
  179.    Look, I just wrote the damn thing. What you do with it is your
  180.    business. I'm not responsible for any catastrophe that you may cause
  181.    by using WAD Tools. If you permanently damage your WAD file, too
  182.    bad.  If it formats your hard drive, too bad. Of course, I took
  183.    every precaution to insure that Wad Tools is a (mostly) bug-free
  184.    program and that it WON'T format your hard drive, but if it does...
  185.    Oh well.
  186.  
  187.  
  188. Author/Misc info
  189. ================
  190.  
  191.    WAD Tools was created by Jeff Miller, a programmer obsessed with
  192.    finding out the format for DOOM level data. Dan Cervelli, another
  193.    mad-scientist type of guy, provided sort code and additional
  194.    brainpower for figuring out file formats.  id Software also helped
  195.    out by actually making DOOM.
  196.  
  197.    WAD Tools is freeware. Distribute it like crazy. Give it to everyone
  198.    you know.
  199.  
  200.    Feel free to send any comments, ideas, suggestions, etc. to
  201.    atomicus@indirect.com. The real name on the account will say Dan
  202.    Cervelli, but don't worry, I'll get it.
  203.  
  204.    For all the latest Quake news and insane babble, finger John Romero,
  205.    johnr@idsoftware.com. Also try John Carmack, johnc@idsoftware.com.
  206.  
  207.  
  208.